home *** CD-ROM | disk | FTP | other *** search
/ L' Effet Pommier 3 / L'Effet Pommier - Volume 03.iso / Disk & Fichiers / Checksum 1.3 / Checksum 1.3 User’s Manual < prev    next >
Text File  |  1996-01-17  |  25KB  |  517 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17. Ñ    Introduction
  18. Ñ    System Requirements
  19. Ñ    Trademarks
  20. Ñ    License Agreement and Registration Information
  21. Ñ    The Status Window Display
  22. Ñ    Usage
  23. Ñ    Menus
  24. Ñ    Version History
  25. Ñ    Future enhancements
  26. Ñ    Questions or Problems?
  27. Ñ    Registration
  28.  
  29.  
  30.  
  31. Welcome to Checksum for the Macintosh, a complete file checksum program. Checksum is a program that allows anyone to quickly and easily calculate file checksums. Briefly, a checksum is a number calculated for a file by performing some operation on all the characters in the file, such as adding up all the character values and generating a total. A checksum is useful for testing the integrity of a file ╤ the calculated checksum can either be compared against a previously calculated checksum, or the checksum can be compared against a checksum for a file on another computer. Checksum is the easiest way to compare two files on Macintosh computers (either on the same machine or different ones), to tell if they are identical or not! If the checksum values match, there is an extremely good chance the files are identical. The choice of checksum algorithm affects the chance that two files are identical if their checksums match.
  32.  
  33. Some of the key features of Checksum are:
  34.  
  35. Ñ    Most popular checksum algorithms are supported
  36.  
  37. Ñ    Checksum is compatible with most checksum programs on other systems, e.g., the Unix ╥sum╙ program and the POSIX.2 ╥cksum╙
  38.  
  39. Ñ    Checksum can specially treat ╘TEXT╒ file end-of-line characters to be compatible with Unix or MS-DOS systems
  40.  
  41. Ñ    Checksum is fully System 7 and 32 bit addressing compatible, including Apple Events, balloon help and ╥drag and drop╙
  42.  
  43. Ñ    Checksum can calculate checksums for files, folders, volumes and even alias files
  44.  
  45. Ñ    Checksum is business-ware ╤ free for individuals and for education, but organizations must pay if they use it
  46.  
  47. The results from Checksum are displayed in a window on the screen. Results can be copied to the Clipboard to use in other applications.
  48.  
  49.  
  50. Checksum will run on a Mac Plus or later. System 6 or System 7 is required.
  51.  
  52.  
  53.  
  54. Apple and Macintosh are registered trademarks of Apple Corp.
  55.  
  56. Unix¬ is a registered trademark of Unix System Laboratories, Inc.
  57.  
  58. MS-DOS¿ is a registered trademark of Microsoft Corp.
  59.  
  60. Sun OS and Solaris are registered trademarks of Sun Microsystems
  61.  
  62. The MD5 Message-Digest Algorithm is by RSA Data Security, Inc.
  63.  
  64. All other trademarks held by their respective owners
  65.  
  66.  
  67. Please read this license carefully before keeping this software. By keeping and/or using the software, you are agreeing to be bound by the terms of this license. If you do not agree to the terms of this license, you are not authorized to use this software and must delete it. Use and distribution of this software is governed by the following terms to reasonably ensure this software will remain freely available and that no one other than the author will derive a commercial benefit from distributing this software.
  68.  
  69. ╥You,╙ ╥your,╙ and the ╥user╙ refers to any person or entity which acquires or uses this software.
  70.  
  71. ╥Software,╙ ╥program╙ and ╥application╙ refers to any computer programs identified at the start of this documentation file, together with all codes, techniques, software tools, formats, designs, concepts, methods, ideas and documentation associated with the computer program(s). The term also includes all copies of any part of the software and documentation.
  72.  
  73. ╥Author╙ refers to the author of this software, Geoff Walsh.
  74.  
  75. License: The application and documentation accompanying this License, whether on disk, in read only memory, or on any other media is licensed to you by the author. This software is owned by the author and contains valuable and proprietary information of the author. You own the disk on which the software is recorded.
  76.  
  77. This Checksum program for the Apple Macintosh, and its accompanying documentation, is distributed as businessware. It is freeware for personal use on a single CPU and for educational institutions to use for instructional uses. However, it must be licensed for use within a business, corporation or organization. This includes government agencies. The license fee is $10 U.S. for each computer on which the application is used.
  78.  
  79. If you are a shareware distributor, you may distribute this software as long as you contact the author for permission first. You must distribute all of the files intact and in unmodified form, and may not charge more than a reasonable disk copying fee.
  80.  
  81. This software must be registered using the accompanying registration form and paying the appropriate businessware fees. Individuals using the software for personal use and educational institutions are encouraged to register their copies so they can be informed of future updates.
  82.  
  83. Restrictions: This software and documentation contains copyrighted material, trade secrets and other proprietary material and in order to protect them you may not reverse engineer, decompile, disassemble or otherwise attempt to convert the software to a human-perceivable form. You may not modify, network, rent, lease, loan, distribute or create derivative works based upon this software in whole or in part.
  84.  
  85. Termination: This License is effective until terminated. You may terminate this License at any time by destroying the software and related documentation and all copies thereof. This License will terminate immediately without notice if you fail to comply with any provision of this License. Upon termination you must destroy the software and related documentation and all copies thereof in your possession and cease distributing the same.
  86.  
  87. U. S. Government Restricted Rights: This software is provided with RESTRICTED RIGHTS. Use, duplication or disclosure by the government is subject to restrictions set forth in subparagraph (b)(3)(ii) of The Rights in Technical Data and Computer Software clause at 252.227-7013. Manufacturer is Geoff Walsh, P. O. Box 10, Malibu, California 90265-0010.
  88.  
  89. Disclaimer of Warranty on Software: You expressly acknowledge and agree that use of this software is at your sole risk. The software and related documentation are provided ╥AS IS╙ and without warranty of any kind and the author expressly disclaims all warranties, express or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The author does not warrant that the functions contained in the software will meet your requirements, or that the operation of the software will be uninterrupted or error-free, or that defects in the software will be corrected. Furthermore, the author does not warrant or make any representations regarding the use or the results of the use of the software or related documentation in terms of their correctness, accuracy, reliability, or otherwise. No oral or written information or advice given by the author shall create a warranty or in any way increase the scope of this warranty. Should the software prove defective, you assume the entire cost of all necessary servicing, repair or correction. Some states do not allow the exclusion of implied warranties, so the above exclusion may not apply to you.
  90.  
  91. Although the author would appreciate any feedback or bug reports, the author shall not be responsible for correcting any problems which you discover or otherwise help you maintain and use this software. Furthermore, the author may at any time replace, modify, alter, improve, enhance or change this software.
  92.  
  93. Limitation of Liability: Under no circumstances, including negligence, shall the author be liable for any incidental, special or consequential damages that result from the use or inability to use this software or related documentation, even if the author has been advised of the possibility of such damages. Some states do not allow the limitation or exclusion of liability for incidental or consequential damages so the above limitation or exclusion may not apply to you.
  94.  
  95. Controlling Law and Severability: This License shall be governed by and construed in accordance with the laws of the United States and the State of California, as applied to agreements entered into and to be performed entirely within California between California residents. If for any reason a court of competent jurisdiction finds any provision of this License, or portion thereof, to be unenforceable, that provision of the License shall be enforced to the maximum extent permissible so as to effect the intent of the parties, and the remainder of this License shall continue in full force and effect.
  96.  
  97. Complete Agreement: This License constitutes the entire agreement between the parties with respect to the use of this software and related documentation, and supersedes all prior or contemporaneous understandings or agreements, written or oral, regarding such subject matter. No amendment to or modification of this License will be binding unless in writing and signed by a duly authorized representative of the author.
  98.  
  99.  
  100. The status window is used to display the checksum results. The status window is fully movable and resizable. The display can be scrolled if more information is present than will fit within the window. The status window can only be written by the checksum program ╤ the keyboard cannot add to or modify its contents. However, any information in the status display window can be selected and copied to the Macintosh clipboard.
  101.  
  102. The status window will appear like:
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115. The calculated checksum value is the result as a decimal number. This is what the Checksum application calculates when a file is opened. If a CRC algorithm is used, the result is also shown as a hexadecimal (base 16) value in parentheses.
  116.  
  117. The block count is the number of blocks in the file. This field is mostly for compatibility with the Unix sum program. If the System V checksum algorithm is used, the block size is 512 bytes; for all other checksum algorithms, the block size is 1024 bytes.
  118.  
  119. The byte count is the number of bytes processed during the checksum calculation. Note that this may not be the same as the number of bytes in the file, depending on which file forks are selected and whether ╘TEXT╒ file end-of-line translation is set to MS-DOS.
  120.  
  121. The file name is simply the name of the file opened.
  122.  
  123.  
  124. Here are some possible ways to use Checksum:
  125.  
  126. 1. Compare 2 files to determine whether they are the same or not.
  127.  
  128. Calculate the checksum for each file and compare the results. The files can be on the same system, on different disks, or on two totally different machines (possibly even in different countries). If the checksum for each file is the same, the files are probably the same.
  129.  
  130. Make sure the same checksum algorithm is used on both files. For best results, use any one of the 32-bit CRC options. Also, make sure that both Data fork and Resource fork options are selected.
  131.  
  132. Both files don╒t even have to be on Macintosh systems. For example, if one of the files is on a Unix system, the ╥sum╙ command can be used to calculate a checksum for one of the files.
  133.  
  134. 2. Determine whether a file has changed over time.
  135.  
  136. If there is a file which may change over time, calculate the checksum for the file and permanently record the results (e.g., with the Save As╔ option). When you need to determine whether the file has changed, re-calculate the checksum for the file and compare the two calculated values.
  137.  
  138. 3. Calculate the checksum for an entire directory
  139.  
  140. In the Standard File selection dialog which appears when Open╔ is selected, press the shift key. The default Open button will change to Select. A folder, volume or alias file can be selected. If a folder or volume is selected, a checksum will be calculated for every file contained in the folder or volume.
  141.  
  142. System 7 users can also drag the folder or volume icon to the Checksum application icon in the Finder. If you have used an earlier version of Checksum, you will need to rebuild the desktop file for this feature to work. Press the command and option keys when you restart your Macintosh to rebuild the desktop file.
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159. The File menu contains all the commands usually associated with opening and saving files:
  160.  
  161. New will open a new status display window. Only one status display window can be open at a time.
  162.  
  163. Open╔ will open a file and calculate a checksum. Results are presented in the status window. A status window must be active in order to open files to calculate checksums.
  164.  
  165. Pressing the shift key will let you select a folder, volume or alias instead of the normal open action. The Open button will change to Select and allow you to select any special type of file.
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181. Close will close the status window.
  182.  
  183. Save As╔ will save the results in the status window to a file. The file will be a text file which can be opened by an application such as TeachText.
  184.  
  185. Results╔ will present a dialog which lets you determine the location and format of calculated results. Results can be saved as either reported text as in previous version, or formatted for input to spreadsheet applications.
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205. The default operation is for results to display on the screen, as in earlier versions. When ╥Results to disk╙ is selected, all calculated checksum information is saved directly to a disk file; a log of selected items is displayed on the screen. Note that there is still a 32K limit on the size of the on-screen log, which should be adequate for most applications.
  206.  
  207. Results can be save to disk in either ╘TEXT╒ format, which is the same as in earlier versions, or in delimited fields suitable for input to a spreadsheet application. Spreadsheet column delimiters can be either tab, comma or carriage return characters.
  208.  
  209. The file creator can be specified for text and spreadsheet formatted files. The default creator for ╘TEXT╒ files is TeachText/SimpleText (as in previous versions). The default creator for ╥Spreadsheet╙ formatted files is Microsoft Excel. The creator can be specified by either typing the 4 character creator string, or by selecting the creator application using the standard file dialog. The file type will be ╘TEXT╒ for all files created.
  210.  
  211. The ╥Include column header╙ is not yet implemented. The ╥Other╙ disk format option is not yet implemented. They are reserved for future capabilities.
  212.  
  213. Quit will quit the Checksum application. Unsaved changes to the on-screen window can be saved before the application quits.
  214.  
  215. Page Setup╔ and Print╔ aren╒t implemented in this version of Checksum. If you need to print Checksum results, Copy the status window display to the clipboard, Paste into TeachText, a word processor or text editor, and print. Alternatively, the saved results file can be printed from another application.
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229. The Edit menu contains the commands associated with the Macintosh clipboard.
  230.  
  231. Copy will copy the selected text to the clipboard.
  232.  
  233. Select All will select all the results in the status window. The Copy command must still be used to copy all the text to the clipboard.
  234.  
  235. The Preferences╔ menu option provides a dialog which lets you choose specific options depending on your needs. The default settings match earlier Checksum versions.
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253. Show Full pathnames will provide the complete path description for a file, instead of just the base filename. Partial pathnames will display path names relative to the folder selected. File names only will only show the base filename as it appears in the standard open file dialog box.
  254.  
  255. Report file forks separately will calculate checksums for each file fork independently and report two separate values. Note that if ╘TEXT╒ special has been selected, both file forks will be reported, but only the data fork will have its end-of-line character optionally translated. The data fork is calculated before the resource fork.
  256.  
  257. Report folder totals will calculate an additional checksum for all the files in the folder as if they were concatenated together. The are combined in the order they are shown in the results.
  258.  
  259. Show file size in blocks will optionally report the block count. Similarly, Show file size in bytes will optionally report the number of bytes in the file. If Report file forks separately is selected, separate block and/or byte counts will be reported for each file fork.
  260.  
  261. Report throughput will report the approximate performance of the checksum algorithm for your system. Many factors will affect checksum throughput: processor speed, disk I/O performance, operating system and extensions, and disk cache settings. For best results, very large files will give the most accurate measurements of actual performance, but results should be averaged over a large number of files to get a meaningful measure for comparison purposes. The value reported has little worth on its own.
  262.  
  263. Undo, Cut, Paste and Clear are not valid menu options, but are included for compatibility with desk accessories.
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278. The Options menu controls how the checksum is calculated. The default settings should provide maximum compatibility with the Unix ╥sum╙ utility.
  279.  
  280. System V will use the original AT&T Bell Labs checksum algorithm. This is not a very ╥strong╙ checksum method, i.e., the chance of identical checksums for different files is greater than for other algorithms. This algorithm is provided mainly for compatibility with System V Unix implementations.
  281.  
  282. BSD will use the checksum algorithm traditionally found on Berkeley 4.x based Unix systems (e.g., Sun OS/Solaris). On System V Unix implementations, the ╥sum -r╙ command will usually produce the same values as this option.
  283.  
  284. CRC will use a stronger algorithm than either the System V or BSD options. Cyclic Redundancy Check (CRC) checksums are a family of algorithms. The ╥CRC Options╙ submenu is active only when CRC is selected. The ╥CRC Options╙ submenu determines which CRC algorithm is used.
  285.  
  286. The RSA MD5 checksum option is a complete implementation of the RSA Data Security, Inc. MD5 Message-Digest Algorithm. A message digest algorithm is a cryptographic checksum that ensures even a small change in the input file results in a large change in the calculated checksum. MD5 generates a 128-bit (16 byte) ╥signature╙ for any given file. MD5 is near the state of the art for cryptographic checksum algorithms. It is conjectured that it is computationally infeasible to produce two messages having the same message digest, or to produce any message having a given prespecified target message digest. A complete technical description of the MD5 algorithm can be found in Internet RFC 1321.
  287.  
  288. Data Fork will calculate a checksum value which includes the file╒s data fork.
  289.  
  290. Resource Fork will calculate a checksum value which includes the file╒s resource fork. For consistency between files, the Finder Information portion of the resource fork (bytes 16 to 127) is ignored in the checksum calculation.
  291.  
  292. Note: when both ╥Data Fork╙ and ╥Resource Fork╙ are selected, the file is treated as one contiguous file, with the file╒s data fork immediately followed by the file╒s resource fork. This is not the same as MacBinary format.
  293.  
  294. ╘TEXT╒ special determines whether files of type ╘TEXT╒ will be treated specially. If ╘TEXT╒ special is selected, the Macintosh end-of-line character (carriage return, ASCII value 13, hexadecimal value 0D) will possibly be treated special for ╘TEXT╒ files and only the data fork will be used, even if ╥Resource Fork╙ is selected. The end-of-line character will be treated as selected in the ╥End-of-line mode╙ submenu.
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310. The CRC Options submenu determines which CRC algorithm is used when CRC is selected from the Options menu. Although the 32 bit CRC methods use the same polynomial, initial values are different, which accounts for different results.
  311.  
  312. CRC 16 is the 16 bit CRC algorithm found in applications such as ARC. The CRC polynomial used is:
  313.  
  314. CCITT 16 is the 16 bit CRC algorithm defined by the CCITT international standards group. (CCITT is the Consultive Committee for International Telephone and Telegraph ╤ a standards organization that sets standards for worldwide voice and data communications.) The CRC polynomial used is: 
  315.  
  316. Zip 32 is the 32 bit CRC algorithm used in the Zip, Compact Pro and Brik applications. The CRC polynomial used is:
  317.  
  318. POSIX.2 is the 32 bit CRC algorithm defined for use in the POSIX.2 ╥cksum╙ utility. The CRC polynomial used is:
  319.  
  320. The POSIX.2 CRC algorithm is slightly different from the other CRC algorithms, although the CRC polynomial is the same.
  321.  
  322. CCITT 32 is the 32 bit CRC algorithm defined by the CCITT international standards group. The CRC polynomial used is:
  323.  
  324. The Custom 16, Custom 32 and Define╔ commands aren╒t implemented in this version. When implemented, they will support custom CRC calculations.
  325.  
  326. Many people has asked about the CRC calculation algorithms used in Checksum. For any CRC polynomial, four values define the calculation: the CRC polynomial coefficients, the initial value, the byte ordering, and number of bits in the result. The following table shows the information that describes the algorithms in Checksum:
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336. Coefficients is the polynomial coefficients represented as a bit-map (in hexadecimal). For example, 0xA001 is the polynomial
  337.  
  338. (note the ╥+1╙ is always implied).
  339.  
  340. Note that the POSIX.2 algorithm differs slightly from the CCITT algorithm, even though the polynomials are the same.
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358. The End-of-line mode submenu determines how the end-of-line character (carriage return) will be treated when a ╘TEXT╒ file is opened if ╥╘TEXT╒ special╙ has been selected from the Options menu. This will allow ╘TEXT╒ files transferred from another operating system to give the same checksum on the Macintosh, even though some end-of-line conversion may have taken place.
  359.  
  360. Macintosh (CR) treats the end-of-line character as is, i.e., there is no conversion.
  361.  
  362. Unix (LF) treats end-of-line characters as a newline character (decimal 10, hexadecimal 0A), instead of as a carriage return. The normal Unix end-of-line character is a line feed. 
  363.  
  364. MS-DOS (CR LF) treats end-of-line characters as a carriage return and line feed pair. This is the normal MS-DOS end-of-line convention.
  365.  
  366.  
  367. Version 1.0 released March 1993. Initial release.
  368.  
  369. Version 1.1 released March 1994. RDA MD5 added, Preferences for display added, improved performance slightly, all known bugs (minor) fixed, and more keyboard functions supported. There are many changes internally to support future upgrades.
  370.  
  371. Version 1.1.1 released June 1994. Two minor bugs fixed: version 1.0 preferences are now read correctly, and the application now quits properly when settings have been changed.
  372.  
  373. Version 1.2 released January 1995. This version now supports Apple Events and the ability to select folders, volumes and alias files. Several minor usability and performance improvements have been made. It now runs on System 6.0.2 and 6.0.3; the Preferences dialog now works on the Mac Plus and SE. Documentation now in PDF format.
  374.  
  375. Version 1.3 released January 1996. New features include the ability to calculate summary checksums for folders and volumes, formatted output suitable for input to spreadsheet applications, no restriction on size of results, and support for background processing.
  376.  
  377.  
  378. This is version 1.3 of Checksum. Depending on support and user feedback, it will be enhanced and maintained. This is still very much a work in progress and the priorities for new features depend on user feedback and support.
  379.  
  380. Some of the planned enhancements include:
  381.  
  382. PowerMac native version
  383.  
  384. Printing
  385.  
  386. Custom CRC definition and calculation
  387.  
  388. Improved user interface for results display
  389.  
  390. Better support for AppleScript
  391.  
  392. Saving calculated checksums in a reference file for automated comparison to validate file integrity.
  393.  
  394. Please send suggestions for improvements you would like to see.
  395.  
  396. If you use this software and want to see these future enhancements, please consider becoming a registered user.
  397.  
  398.  
  399. Verify that you have a good copy of the program. When you receive Checksum and do Get Info from the Finder╒s File menu, you should see:
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421. In its default configuration, Checksum version 1.3 will calculate a checksum for itself which should be:
  422.  
  423. 41556    57 blocks,    58078 bytes ╥Checksum╙
  424.  
  425. If your results don╒t match this, your copy has been modified and is not valid.
  426.  
  427. If you have already been using the checksum program, make sure you are using the correct configuration. Remove the ╥Checksum Preferences╙ file in your System Folder (System 6) or System Folder╒s Preferences folder (System 7). Be sure to rebuild the desktop file on your Macintosh.
  428.  
  429. Checksum has been tested on most Macintosh models running both System 6 and System 7 and is 32-bit clean. If you encounter problems, try restarting your computer will all INITs and Extensions disabled. If the problem persists, please contact me. For correspondence by U.S. mail, use:
  430.  
  431. Geoff Walsh
  432. P. O. Box 10
  433. Malibu, CA  90265-0010
  434.  
  435. For electronic correspondence through the Internet, use:    gpw@cerf.net.
  436. If you want extensive support, please register your software.
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.